[BETA] Campaign-level Forecasts

Get campaign performance forecasts based on the provided parameters.

⚠️ Beta Access Required

Contact your sales representative to gain access to this endpoint and start using it.

It returns a list of daily forecasts for the following metrics:

• Total number of impressions.
• Total number of clicks.
• Total number of purchases.

POST /public/v1/toptimize/forecasting/campaign

Try it

[BETA] Campaign-level Forecasts

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/toptimize/forecasting/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetRoas": 123,
  "budget": {
    "amount": 123,
    "type": "daily"
  },
  "bids": {
    "productIds": [
      "<string>"
    ],
    "inventory": []
  },
  "timeWindow": 7,
  "campaignType": "autobidding"
}
'

200

[
  {
    "forecastDate": "2023-12-25",
    "metrics": [
      {
        "metricName": "<string>",
        "values": {
          "forecastValue": 123,
          "forecastIntervalMin": 123,
          "forecastIntervalMax": 123
        }
      }
    ]
  }
]

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Body

application/json

Request model for campaign forecasts with the new structure.

targetRoas · number · required

Target Return on Ad Spend for the campaign

budget · Budget · object · required

Campaign budget information

Show child attributes

budget. amount · number · required

Budget amount

budget. type · enum<string> · required

Budget type (daily, weekly, monthly)

Available options: daily, weekly, monthly

bids · BidTargets · object · required

Bid targets information

Show child attributes

bids. productIds · string[] · required

List of product IDs to target

bids. inventory · InventoryItem · object[]

Inventory to target

Show child attributes

bids.inventory. inventoryType · enum<string> · required

The type of inventory (category or search)

Available options: category, search

bids.inventory. inventoryValue · string · required

The value of the inventory

timeWindow · integer · default: 7

How many days to forecast into the future

Required range: 1 <= x <= 14

campaignType · enum<string> · default: autobidding

Campaign type (For v1, only autobidding is supported)

Available options: autobidding

Response

200

application/json

Successful Response

forecastDate · string<date> · required

Date of the forecast

metrics · MetricForecast · object[] · required

List of metric forecasts for this date

Show child attributes

metrics. metricName · string · required

Name of the metric being forecasted

metrics. values · ForecastMetricValue · object · required

Forecast values for this metric

Show child attributes

metrics.values. forecastValue · number · required

The forecasted value

metrics.values. forecastIntervalMin · number · required

The lower bound of the confidence interval

metrics.values. forecastIntervalMax · number · required

The upper bound of the confidence interval